Reporting Service

The reporting service contains many DTOs which can be used for the preparation of reports.

ReportAuditEntityDto : ReportEntityDto

This class contains some basic audit data for reporting purpose.

Datatype	Name	Description
Guid	CreatedBy	Unique Id of the user who created the entity
DateTime	Created	TimeStamp of the entity creation
string	CreatedByUser	Name of the user who created the entity
Guid	LastUpdateBy	Unique Id of the user who last updated the entity
DateTime	LastUpdate	TimeStamp of the entity last update
string	LastUpdateByUser	Name of the user who last updated the entity

ReportAttendanceDto

This class contains information about the presence of employees.

Datatype	Name	Description
DateTime	Date	Reported date
AttendanceState	AttendanceState	The attendance state, that can be: // The user is currently in the office Green, // The user make a break Blue, // The user finished work and went home Black, // The user is not at the desk, but because it's not in coverage, we get no further information Gray, // The user did not appear at all, but has a reason for Yellow, // The user did not appear and did not have a reason Red
DateTime?	LastLogOn	Last logon date and time
DateTime?	LastLogOff	Last lopon date and time
String	SpecialInformation	Special information about holiday
ReportUserDto	User	Reported User
ReportActiveTimeEntryDto	TimeEntry	Reported active time entry
ReportDailySummaryDto	DailySummary	Reported daily summary

ReportAuditDataLogDto

This class contains data about a user action that triggered a data change.

Datatype	Name	Description
DateTime	Time	Time of the user interaction
DateTime	StartDate	Start date of user interactions that affect the data
DateTime	EndDate	End date of the user interactions that affect the data
UserAccountType	UserAccountType	Type of the users account, e.g. user account or system account
Guid	PrincipalId	Unique id of the user who started the interaction
String	PrincipalName	Name of the user who started the interaction
String	IdentityId	Unique id of the user who has been affected by the interaction
String	IdentityName	Name of the user who has been affecteded by the interaction
String	Title	Title of the interaction
String	Description	Description of the interaction
Guid?	GroupId	Unique Id that groups combined interactions
String	Origin	Name of the module in that the interaction started
String	Fault	Error message, if the interaction failed

ReportAuditObjectModificationDto

This class contains all the data about an object change that has been made.

Datatype	Name	Description
Modification	ObjectModification	Type of the object Modification, e.g. new, modify or delete
String	ObjectType	Type name of the object that has been changed
Guid	ObjectId	Unique Id of the object that has been changed
String	ObjectDisplayName	Display name of the object that has been changed
String	AdditionalInfo	Additional information to an object change

ReportAuditFieldModificationDto

This class contains all the data for a field change that has been made.

Datatype	Name	Description
Modification	FieldModification	Type of the field Modification, e.g. new, modify or delete
String	OldValue	The old technical value
String	NewValue	The new technical value
String	OldDisplayValue	The old display value
String	NewDisplayValue	The new display value
String	PropertyName	The name of the Property that has been changed
String	FieldDisplayName	the display name of the property that has been changed
String	TypeName	The property Type name
bool	IsForeignKey	True, if the field contains a foreign key id
String	ForeignType	If IsForeignKey is true, the field contains the name of the foreign type

ReportCustomerDto : ReportAuditEntityDto

This class contains all customer data that is relevant for report generation.

Datatype	Name	Description
Guid	CustomerId	Unique Id of the Customer in TimePunch
String	CustomerName	Name of the customer
String	CustomerRefNr	Ref. No. of the customer
String	Website	URL of the customers website
String	ContactPerson	Contact person of the customer
String	ContactPersonJobPosition	Job that the contact person of the customer owns.
String	EMailAddress	Email Address of the customer
String	PostalAddress	Postal address of the customer
String	PhoneNumber	Phone number of the customer
String	FaxNumber	Fax number of the customer
String	MobileNumber	Mobile number of the customer
String	Notes	Notes of the customer
String	VatRegNo	Vat No. of the customer
ColumnFlagsFor TimeSheetExport	ColumnFlags	[Currently not used] Columns for time sheet export to the customer
String	ExportTimeSheet MailTemplate	[Currently not used] Mail template for the time sheet export
SyncTimeSheetFlags	SyncSheetFlags	[Currently not used] Timesheet syncrhonize options
Bool	IsCustomerDeleted	True, if the customer has been deleted in TimePunch.
String	CustomerCode	Barcode of a customer. Used to identify the customer by its barcode.

ReportDailySummaryDto : ReportAuditEntityDto

This class contains the report data for daily reporting.

Datatype	Name	Description
ReportSummaryDto	Summary	Reference to the monthly summary
ReportWorkdayDto	Workday	Workday model for the reported working day.
DateTime	Date	Reported date
DateTime?	LogonTime	Earliest logon at the date
DateTime?	LogoffTime	Latest logoff at the date
String	Description	Description text of the reported date
Double	AbsDailyOvertime	Absolute daily overtime. This value is always >0 or 0.
Double	AbsDailyMinustime	Absolute daily minus time. This value is always >0 or 0.
Double	DailyEstimatedWorktime	Estimated working time at the given date.
Double	DailyEstimatedPaidtime	Estimated paid time at the given date.
Double	DailyOvertime	Daily overtime, this value can also be negative.
Double	DailyBankHoliday	Daily bank holiday hours
Double	DailyBankHolidayAsDays	Daily bank holiday as part of day
Double	DailySpecialLeave	Daily special leave hours
Double	DailySpecialLeaveAsDays	Daily special leave as part of day
Double	DailyAbsence	Daily absence hours
Double	DailyAbsenceAsDays	Daily absence as part of day
Double	CurrentOvertime	Current overtime at the given date
Double	DailySickComplete	Daily sick and sick not paid hours
Double	DailySickCompleteAsDays	Daily sick and sick not paid as part of day
Double	DailySickNotPaid	Daily sick not paid hours
Double	DailySickNotPaidAsDays	Daily sick not paid as part of day
Double	DailySick	Daily sick hours
Double	DailySickAsDays	Daily sick as part of day
Double	DailyTakenOvertime	Daily taken overtime
Double	DailyTakenOvertimeAsDays	Daily taken overtime as part of day
Double	DailyLeave	Daily leave hours
Double	DailyPaidLeave	Daily paid leave hours, This can vary from the daily leave if the payout gets calculated by the last 13 weeks
Double	DailyLeaveAsDays	Daily leave as part of day
Double	DailySpareTime	Daily spare time hours
Double	DailySpareTimeAsDays	Daily spare time as part of day
Double	DailyBreaktime	Daily break time hours
TimeEntryType	DailyUsage	Aggregated main usage of the day
DateTime?	LogonTimeUncut	Uncutted logon time, even if the cutter did run
DateTime?	LogoffTimeUncut	Uncutted logoff time, even if the cutter did run
Double	DailyNightSurchargeCoretime	Daily night surcharged core time
Double	DailyNightSurchargeTime	Daily night surcharged time
Double	DailySaturdayWorktime	Daily saturday worktime
Double	DailySundayWorktime	Daily Sunday worktime
Double	DailyPublicHolidayWorktime	Daily public holiday worktime
Double	DailySaturdayWorktimeAm	Daily worktime at Saturday morning
Double	DailySaturdayWorktimePm	Daily worktime at Saturday afternoon
Double	DailySurchargedOvertime	Daily surcharged overtime
Double	DailyOnCallServicetime	Daily on call service time
Double	DailyOnCallServicetimeAsDays	Daily on call service time as part of day
Double	DailyPaidSick	Daily paid sick time
Double	DailyPaidBankHoliday	Daily paid bank holiday time
Double	DailyShortTimeWork	Daily short time work hours
Double	DailyWorktimeOffset	Daily worktime offset
Double	DailyEstimatedTotalTime	Daily estimated total time
Double	DailyTotalTime	Daily total time
Double?	DailyPaidTime	Daily paid time
Double	DailyCutTime	Daily cutted time

ReportDSGVOInfoDto

This class contains the report data for the information form of the General Data Protection Regulation which comes into force on 25.05.2018.

Datatype	Name	Description
ReportUserDto	User	Defines the user for that the report contains data.
DateTime?	FirstEntry	Date/Time of the first timeentry of the user
DateTime?	LastEntry	Date/Time of the last timeentry of the user
DateTime?	LockedUpTo	Date up to when the timeentries has been locked.
Double	WorkdaysPerWeek	Count the workdays per week
Double	HoursPerWeek	Amount of working hours per week
List\<ReportLeadingUserDto>	LeadingUsers	List of the users who have access to the personal data of the user

ReportLeadingUserDto

This class contains all information about the users who have access to other employees.

Datatype	Name	Description
Guid	UserId	Defines the id of the leading user
String	LogonName	Logon name of the leading user
String	UserName	User name of the leading user
String	Email	Email of the leading user
UserRights	Rights	User rights of the leading user
Guid	CoveredUserId	User Id of the user that can be accessed by the leading user
String	CoveredLogonName	Logon name of the user that is covered by the leading user
String	CoveredUserName	User name of the user that is covered by the leading user
String	CoveredEmail	Email of the user that is covered by the leading user
Guid	Id	Unique identifier of the object

ReportOrganizationUnitDto : ReportAuditEntityDto

This class contains all information about an organizational unit.

Datatype	Name	Description
string	OrgaName	Name of the Organisation
string	OrgaPhoneNumber	Phone number of the Organisation
string	OrgaFaxNumber	Fax number of the Organisation
string	OrgaMobileNumber	Mobile number of the Organisation
string	OrgaEmail	Email of the Organisation
string	OrgaPostcode	Post code of the Organisation
string	OrgaCity	City of the Organisation
string	OrgaCountry	Country code of the Organisation
string	OrgaStreet	Street name of the Organisation
string	OrgaStreetNumber	Street number of the Organisation
string	OrgaAddressAddition	Address Addition of the Organisation
string	OrgaCompanyNo	Company number of the Organisation
string	OrgaRoomNo	Room number of the Organisation
string	OrgaPostalAddress	Postal address that has been composed of the previous values, when saving the Organisation unit
string	OrgaTaxConsultantNo	Number of the tax consultant, previously stored in the configuration settings
string	OrgaTaxClientNo	Tax client number of the Organisation, previously stored in the configuration settings

ReportProjectDto : ReportAuditEntityDto

This class contains all project-related data that can be used for reporting.

Datatype	Name	Description
ReportCustomerDto	Customer	Defines the customer that can be set for project.
Guid?	CustomerId	The Id of the customer or NULL if o customer has been set.
DateTime?	ReportingDate	The date where the reporting has been requested.
Guid	ProjectId	The id of the project.
Guid	ParentProjectId	The id of the parent project.
Guid	ProjectOwnerId	The Id of the project owner. The id is always an employee id.
String	ProjectOwner	The user name of the project owner.
String	Currency	The currency that has been defined for the project.
Double	ProjectPricePerHour	The price per hour defined for the given project.
Double	Vat	The vat tht is used to calculate the gross amount for the current project.
Long	TextColor	The text color that is used to display the time entries that are related to the project.
Long	BackgroundColor	The background color that is used to display the time entries that are related to the project.
String	ProjectName	The name of the project
String	ProjectDescription	The description of the project
ProjectLifeCycle	ProjectLifeCycle	The current project life cycle of the project (e.g. Planning/Active/Done/Deleted)
Bool	IsProjectTimeLimited	True, if the project has a fixed ending.
DateTime	StartDate	The first date from that the project can be booked
DateTime	EndDate	The last date until that the project can be booked.
List\<ReportTaskDto>	TaskList	Collection of project related tasks
ProjectAvailibility	ProjectAvailibility	Defines if the project is useable by all, none or only a few AvailableForAll = 0 AvailableForSelected = 1 AvailableForNone = 2
List\<ReportProjectUserDto>	UserRelations	Collection of users that are related to the project
Int?	ProjectMembersCount	Number of project members. If project is available for all or only admins, then it’s null
Double?	ProjectMaxWorkingTime	The maximum amount of working time that has been defined at the project.
Int	RoundPrecisionInMinutes	The rounding in minutes that has been defined in the project data.
Rounding	Rounding	Defined rounding for the project invoicing. NotRounded = 0 Rounded = 1 RoundUp = 2 RoundDown = 3
Double	YellowTrafficLight	The percentage of worktime to available work where the project will turn yellow
Double	RedTrafficLight	The percentage of worktime to available work where the project will turn red
Double?	ProjectChargingJourneyTime	The percentage of driving time that is calculated as working time.
ProjectState	ManualProjectState	The manual project state Calculated = 0 Green = 1 Yellow = 2 Red = 3
String	ProjectStateDescription	The description that explains the current project state, if the project state has been set manually
Bool	DontInheritCommonTasks	True, if the project does not inherit common tasks, e.g. does not show it.
Bool	IsOrderBased	True, if the project is order based and offers special input fields for that.
String	Account	The internal account that can be used for worktime accumulation.
String	CostCenter	The cost center for the project that can be used for export tasks.
OrderType	OrderType	A business driven order type. Undefined = 0 PrivateSector = 1 PublicService = 2 SupplyOfTemporaryWorkers = 3 ServiceContract = 4 ContractToProduceAWork = 5
String	ContractId	The project based contract id
String	PlaceOfServiceProvision	Address where the service will be provided.
Bool	IsProjectTimeSet	True, if the project has a defined amount of work
Double	SharedPool	Defined working time for the shared pool
Double	PrivatePool	Defined working time for the private pools
Double	ScheduledWork	Scheduled work of the project.
Double	HoursWorked	Hours that have already been worked at the project.
Double	AvailableWork	Available hours that can be booked.
String	FurtherAccountingDetails	User specific data used to concrete the project accounting
String	ProjectCode	Barcode of a project. Used to identify a project by its barcode.

ReportProjectTimeDto

This class contains additional information about the project in connection with the employee and the planned, completed and open project budget.

Datatype	Name	Description
ReportUserDto	User	TimePunch related user data
ReportProjectUserDto	ProjectUser	Project related user data
ReportProjectDto	Project	Project data
String	PoolType	Type of the project pool S Shared pool P Private pool
Date?	Date	Reference data for that the evaluated times are valid.
Double	UserScheduledWork	Scheduled work for the user and project
Double	UserHoursWorked	Already worked hours by user for the project
Double	UserAvailableWork	Available hours that can be allocated by the user for the project.

ReportProjectUserDto : ReportAuditEntityDto

This class contains specific information about an employee in connection with a project.

Datatype	Name	Description
Guid	UserProjectId	Project Id
Guid	ProjectUserId	User Id
Bool?	IsAllowedToUseProject	True, if the user is allowed to book the project
Double?	UserPricePerHour	Price per hours that is defined for the user within the given project. Null, if no special price has been set.
Double?	UserMaxWorkingTime	Max working time that is defined for the user within the given project. Null, if no max working time has been set.
Guid?	UserCustomerId	Customer Id that is defined for the user within the given project. Null, if no special customer id has been set.
Double?	UserChargingJourneyTime	Percentage of charged journey time for the user within the given project. Null, if no special charging has been set.

ReportSalaryExportDto : ReportAuditEntityDto

This class contains the fields that contain the wage types for the bonus types, the times set for the night bonus, and so on.

Datatype	Name	Description
double?	NightShiftStartTime	If not null, the start time of the night shift
double?	NightShiftEndTime1	If not null, the end time of the core night shift
double?	NightShiftEndTime2	If not null, the end time of the extended night shift.
double?	SaturdaySplitTime	If not null, the time that splits the Saturday morning from the Saturday afternoon
String	FixedSalaryTypeNo	Type no of the fixed salary
String	TemporaryHourlyWageTypeNo	Type no of a temporary worker
String	HourlyWageTypeNo	Type no of a regular wage worker
String	SicknessTypeNo	Type no of a continued sick payment
String	LeaveTypNo	Type no of a continued leave payment
String	SpecialLeaveTypeNo	Type no of a special leave payment
String	PaidOvertimeTypeNo	Type no of a paid overtime
String	OfficialBankHolidayTypeNo	Type no of a continued bank holiday payment
String	SaturdayWorkAmTypeNo	Type no of a Saturday morning work
String	SaturdayWorkPmTypeNo	Type no of a Saturday afternoon work
String	SundayWorkTypeNo	Type no of a Sunday work type no
String	NightShiftTypeNo	Type no of the etendend night shift
String	NightShiftCoreTypeNo	Type no of the night shift core time
String	OvertimeTypeNo	Type no of the surcharged overtime
String	OnCallServiceTypeNo	Type no of the on call service payment
String	ShortTimeWorkTypeNo	Type no of the short time work payment
String	SicknessNotPaidTypeNo	Type no of the sickness that is not paid
String	StatisticLeaveAsDaysTypeNo	Type no of the taken leave days
String	StatisticSickAsDaysTypeNo	Type no of the sick days
String	StatisticRemainingLeaveAsDaysTypeNo	Type no of the remaining leave days
String	StatisticWorkAccountTypeNo	Type no of the working account

ReportSalaryTimeDto : ReportEntityDto

This class contains the fields that will be used to report the salary trimes to datav, lexware or other payroll software.

Datatype	Name	Description
ReportUserDto	User	The user object for which the salary shall be exported
DateTime	ReportedDate	The export date / in case of a monthly export, it's alwayws the first date in month
SalaryType	SalaryType	The type of salary or wage
double?	HourlyWage	The hourly wage
String	CostCenter	The cost center of the booked project
String	PersonnelNumber	The personnel number of the employee
String	BookingAccount	The booking account that has been defined in the ReportSalaryExportDto

ReportSummaryDto

This class contains all the important data for monthly reporting.

Datatype	Name	Description
ReportYearlySummaryDto	YearlySummary	Yearly summary data
ReportWorkModelDto	WorkModel	Active Workmodel for the given reporting date.
Int	Month	Number of the reported month (e.g. 1-12)
Double	EstimatedWorkdaysPerMonth	Amount of estimated workdays per month
Double	EstimatedWorktimePerMonth	Estimated worktime per month.
Double	EstimatedPaidtimePerMonth	Estimated paid time per month.
Double	EstimatedWorktimePerMonth Regular	Estimated worktime per month, if the current workmodel is defined as short time work.
Double	Overtime	Overtime in the given month.
Double	CalculatedOvertime	Calculated overtime for the given month. The calculated overtime is the total overtime before the overtime cut.
Double	Breaktime	Amount of breaktime in month.
Double	Drivetime	Amount of drivetime in month.
Double	Sparetime	Amount of sparetime in month.
Double	Worktime	Amount of worktime in month.
Double	TakenOvertime	Amount of taken overtime in month.
Double	Leave	Amount of leave in month.
Double	PaidLeave	Amount of paid leave hours in month. This can vary from the leave, if the paid leave gets calculated by the average of the last 13 weeks.
Double	LeaveAsDays	Amount of leave days in month.
Double	SickComplete	Amount of sick hours and sick not paid hours in month.
Double	SickCompleteAsDays	Amount of sick days and sick not paid days a month.
Double	Sick	Amount of sick time in month.
Double	SickAsDays	Amount of sick days in month.
Double	SickNotPaid	Amount of sick not paid hours in month.
Double	SickNotPaidAsDays	Amount of sick not paid as days in month.
Double	TotalOvertime	Total overtime in month.
Bool	Locked	True, if the month-end closing has been done.
DateTime	Date	The first date in month.
OvertimeCutMode	OvertimeCutMode	Defines when the overtime gets cutted, e.g on monthly basis or at all (cumulative)
Bool	IsPaidOvertimeCalculated	True, if the paid overtime gets automatically calculated.
Double	PaidOvertime	Amount of paid overtime in month.
Double	DecreasePaidTime	Amount of hours that will decrease the payout to the user.
Double	MissingHourCompensation	Amount of working time that gets added to the monthly working time.
Guid	RegionId	Selected region in the current month.
Guid	CountryId	Selected country in the current month.
Double	MaximumOvertime	The maximum overtime in the curren month.
Double	OvertimeStartsAt	Default value above the additional working time gets counted as overtime.
Bool	ExceptionForMinusWorkingTimeAccount	Defines, if there is an exception for minus working account (eg. User has negative working account)
WorkContract	WorkContract	The work contract of the user Employee = 0 Freelancer = 1 Wageworker = 2 Shiftworker = 3
Double?	PaidTime	Amount of paid time in month
Double	UnpaidTime	Amount of unpaid time in month
Double	BankHoliday	Amount of bank holiday in the current month.
Double	BankHolidayAsDays	Time at bank holidays per month. e.g. 1 equals 1 day, 0.5 equals half day
String	CountryName	Name of the country
String	RegionName	Name of the region
Double	PreviousMonthOvertime	Amount of overtime from the previous month.
Double	SpecialLeave	Amount of special leave in month
Double	SpecialLeaveAsDays	Amount of special leave as days in month
Double	PaidSick	Paid sick time, that can differ from real sick time (13 weeks average)
Double	PaidBankHoliday	Paid bank holiday time, that can differ from real bank holiday time (13 weeks average)
Double	ShortTimeWork	Number of short-time work hours in month
Double	WorktimeOffset	Amount of cummulated work time offsets
Double	EstimatedTotalTimePerMonth	Estimated total time in month
Double	TotalTime	Total time in month
Double	NightSurchargeCoreTime	Amount of night surcharged core time in month
Double	NightSurchargeTime	Amount of night surcharged time in month
Double	NightSurchargeTimeComplete	Amount of night surcharged complete time in month = core + non core
Double	SaturdayWorkTime	Amount of saturday worktime in month = Am + Pm
Double	SundayWorkTime	Amount of sunday worktime in month
Double	PublicHolidayWorkTime	Amount of public holiday worktime in month
Double	SaturdayWorkTimeAm	Amount of saturday worktime AM
Double	SaturdayWorkTimePm	Amount of saturday worktime PM
Double	CutTime	Amount of cutted time

ReportTaskDto : ReportAuditEntityDto

This class contains all the data for an task.

Datatype	Name	Description
Guid	TaskId	Unique Id of the task
String	TaskNameId	Business driven Id of the task
String	TaskDescription	Description of the task
Bool	IsTaskDeleted	True, if the task has been deleted.
TimeEntryType	Usage	The usage or booking type of the task.
Double	CostFactor	The costfactor that is provided to calculate the project invoice.
String	TaskCode	Barcode of the task. Used to identify the task by a barcode scanner.
Double	WorktimeFactor	The worktime factor defines which part of duration will be added to the worktime.
String	WorkTypeNo	Booking account type no. that overrides the default type no. for the work
String	OtherTypeNo	Booking account type no that overrides the default type no. for special times (e.g. on call service)
TimeRestriction	WorkTimeRestriction	This field can be set to NoRestriction, TargetTime or SelfDefined
double?	MaxTaskWorkingTimePerDay	If the time restriction is set to self defined, this field defines the max. working time per day that is allowed for booking.

ReportTimeEntryDto : ReportAuditEntityDto

This class contains all the time entry data for report creation.

Datatype	Name	Description
ReportCustomerDto	Customer	Customer details set to the time entry
ReportProjectDto	Project	Project details for the time entry
ReportTaskDto	Task	Task details for the time entry
ReportProjectUserDto	ProjectUser	Project and user related data
ReportUserDto	User	User related data
ReportWorkdayDto	Workday	Information about the workday
Double	PaidWorktTime100	Defines the worktime that the user gets paid
Double	NetAmount	Defines the net amount the user can invoice
Double	GrossAmount	Defines the gross amount the user can invoice
Double	PricePerHour	Defines the price per hour the user can invoice
Double	CalculatedPricePerHour	Defines the calculated price per hour, which is the PricePerHour multiplied by the cost factor of the task
Double?	ChargingJourneyTime	The percentage of charged journey time. The result will be displayed as work time.
Double?	MaxWorkingTime	The maximum working time the user can book
Bool	IsBankHolidayInherited	True, if the referenced data is a public holiday
Bool	IsNonRegularWorkday	True, if the user does not work regulary at this day (e.g. Sunday)
String	BankHoliday	Name of the bank holiday, if the IsBankHolidayInherited value is true
Double	NightSurcharge Coretime100	Number of hours that is within the night surcharge core time
Double	NightSurcharge Time100	Number of hours that is within the night surcharge time
Double	NightSurcharge TimeCompete100	Amount of the night surcharge core time and the night surcharge time
Double	Saturday Worktime100	Amount of Saturday work time
Double	Sunday Worktime100	Amount of Sunday work time
Double	PublicHoliday Worktime100	Amount of public holiday work time
Guid	ProjectId	Id of the related project
Guid	TaskId	Id of the related task
Guid	ProjectUserId	Id of the related project user
DateTime	LogonTime	Start time of the time entry
DateTime	LogoffTime	End time of the time entry
Bool	IsPaid	Flag that defines if the time entry has been paid
TimeEntryType	Usage	Usage or booking type of the time entry
Double	BreakTime100	Amount of booked break time
String	Description	Description of the time entry
Guid?	ProjectCustomerId	Id of the cusomter defined by the project
Guid	TimeEntryId	Id of the time entry
Double	Worktime100	Amount of worktime
Bool	IsImportant	Flag that defines if the time entry is important.
Bool	IsOnSite	Flag that defines if the time entry is onsite.
Bool	IsDataPreview	Flag that defines if the time entry is a data preview entry
Double	LeaveAsDays	Amount of leave days
Double	Leave100	Amount of leave hours
Double	SickAsDays	Amount of sick time as days
Double	Sick100	Amount of sick time as hours
Double	SickNotPaidAsDays	Amount of sick time not paid as days
Double	SickNotPaid100	Amount of sick time not paid as hours
Double	DrivingTimeAsDays	Amount of driving time as days
Double	DrivingTime100	Amount of driving time as hours
Double	TakenOvertimeAsDays	Amount of taken overtime as days
Double	TakenOvertime100	Amount of taken overtime as hours
Int	Days	Amount of days the time entry spans
Bool	IsVirtual	True, if the time entry is only virtual – means calculated and not manually booked by the user
Double	Duration100	The duration of the time span
Double	DurationAsDay	The duration of the time span in fraction of the day
Double	OnCallService100	Amount of on call service time as hours
Double	OnCallServiceAsDays	Amount of on call service time as days
String	LogonOrigin	Defines the system with that the user logged in to TimePunch
String	LogoffOrigin	Defines the system with that the user logged of from TimePunch
Double?	LogonLatitude	GPS Latitude of the Logon
Double?	LogonLongitude	GPS Longitude of the Logon
Double?	LogonGeoAccuracy	GPS Accuracy in meters
String	LogonGeoAddress	GPS Logon Address
Double?	LogoffLatitude	GPS Latitude of the Logoff
Double?	LogoffLongitude	GPS Longitude of the Logoff
Double?	LogoffGeoAccuracy	GPS Accuracy in meters
String	LogoffGeoAddress	GPS Logoff Address
Double	CutTime100	The cutted time of the time entry
bool	IsActiveTimeEntry	True, if the reported time entry is an currently active time entry

ReportUserGroupDto : ReportOrganizationUnitDto

This class contains all data of a user group (team, department, branch)

Datatype	Name	Description
String	GroupName	Name of the group
GroupType	GroupType	Type of the group, e.g. Team, Department, Branch
String	GroupLeader	Nme of the group leader
Guid	GroupLeaderId	User id of the group leader
bool	HasOwnTaxData	True, if the user group has it's own tax data
Guid?	ParentUserGroupId	Id of the parent user group, or null if the parent is the headquarter
string	ParentUserGroupName	Name of the parent user group

ReportUserDto

This class contains all user-specific data for reporting.

Datatype	Name	Description
Guid	UserId	Unique Id of the TimePunch Profile
String	LogonName	Unique Logon name of the TimePunch Profile
String	UserName	User name of the TimePunch Profile
String	PersonnelNumber	Given personnel number.
String	UserCode	Barcode of the staff member. Used to identify a user by its barcode.
Double	DefaultOvertimeStartsAt	Default value above the additional working time gets counted as overtime.
LeaveCarryForward	DefaultLeaveCarryForward	Value that defines when the new leave shall be added to the staff member. Allowed values are BeginOfJanuary through BeginOfDecember.
LeaveExpiration	DefaultLeaveExpiration	Defines when the leave of the previous year will expire. Allowed values are Instantly, Never and EndOfJanuary through EndOfDecember.
UserRights	Rights	The current user profile rights (e.g. None, View, Edit, Full, Human Resource or Admin)
OvertimeCutMode	DefaultOvertimeCutMode	Defines if the overtime shall be cut. Possible values are None, Monthly or Cumulative
Bool	DefaultIsPaidOvertimeCalculated	True, if the overtime gets automatically paid.
DateTime	DefaultBeginOfWork	The default time, when the user starts working. This can be overwritten by any working time model.
WorkContract	DefaultWorkContract	Work contract that is set for the user in the profile.
Double	PreviousOvertime	The overtime with that TimePunch starts the overtime calculation at beginning of the first month.
Double	PreviousSickdays	The amount of sick days with that TimePunch starts the sick day counter at the beginning of the first month.
String	SaveAsName	The user name of the TimePunch Profile if set, or the logon name.
Double	DefaultChargingJourneyTime	Defines how many percentage of the driving time will be booked as working time.
Guid	DefaultRegionId	The default region id, if no other has been defined.
Guid	DefaultCountryId	The default country id, if no other has been defined.
Double	DefaultAnnualVacation	Default value of the annual vacation.
LeaveCalculation	DefaultLeaveCalculation	Defines the default, if user leave is based per hours or per days. Days = 0 Hours = 1
Double	DefaultLeavePerDay	Amount of hours for a leave day
Double?	DefaultPaidTime	The time that the user gets paid per default.
Double	DefaultMaximumOvertime	Default value of the maxium overtime settings for the profile.
LeaveSetting	LeaveSetting	Defines how the leave offset shall be used for calculation. TakeAsOffset => In the first year, the user has extra holiday available, because he/she carry it forward from the previous time recording. TakeAsStatic => In the first year, the user does not own the complete holidays, but the one he entered
LeaveCalculation	DefaultPreviousLeaveCalculation	Defines the default for the previous or initial leave calculation. The previous leave can be based on hours or days.
Double	DefaultPreviousLeavePerDay	The amount of hours that have been previously set as default to define the length of a leave day. The value is hourly based and only used if the previous holiday is defined per hours.
Double?	DefaultRemainingLeave	The leave that will be used instead of the yearly holidays. Only used when LeaveSetting is set to TakeAsStatic. The value is hourly based and NULL, if the leave is counted in days.
Double	DefaultRemainingLeaveAsDays	The leave that will be used instead of the yearly holidays. Only used when LeaveSetting is set to TakeAsStatic.
Double?	DefaultAdditionalLeave	Leave that will be added to the annual leave in the first year. Only used when LeaveSetting is set to TakeAsOffset. The value is hourly based and NULL, if the leave is counted in days.
Double	DefaultAdditionalLeaveAsDays	Leave that will be added to the annual leave in the first year. Only used when LeaveSetting is set to TakeAsOffset.
DateTime	LastSyncTime	Timestamp when the user has been synced time entries.
UserAccountType	UserAccountType	Type of the TimePunch Profile Account (UserAccount, TechnicalAccount)
String	Email	Email Address of the user
Bool	IsUserInCoverage	True, if the user gets covered by the Authenticated Identity Profile.
String	TimeZone	Time Zone Information for the user.
String	Team	Information about the team to that the user belongs
String	Department	Information about the department to that the user belongs
String	Branch	Information about the branch to that the suer belongs.
String	Birthname	Name at birth of the user
String	PrivatePostalAddress	Postal address of the user
DateTime?	Birthday	Birthday of the user
String	Birthplace	Place where the user has been born
String	Nationality	Nationality of the user
DateTime?	DateOfJoining	Date where the user joined the company
String	InsurancePolicyNumber	Number of the insurance policy of ther user
Bool	IsMainJob	True, if the current job is the main job of the user.
Bool	HasOtherJobs	True, if the user has other jobs beside the current one.
String	JobDescription	Description of the current job the user is employed for.
Bool	IsRelatedToEmployer	True, if the user has a relation to the employer (e.g. brother etc)
Bool	IsFreedFromPensionInsurance	True, if the user is freed from pension insurance
String	BankingInstitut	Name of the banking institute for the wage payment or salary
String	InternationalBankAccountNumber	IBAN Number to pay the wage or salary
String	BankIdentifierCode	Bank identifier code
Double	HourlyWage	Hourly wage that the user gets paid.
Double	Salary	Monthly salary the user gets paid.
DateTime?	DateOfLeaving	Date where the user left the company.
String	Md5PassHash	MD5 Password hash
String	Sha256PassHash	SHA 256 Password hash
String	PasswordSalt	Password salt value
Gender	UserGender	Gender of the staff member
String	UserFirstName	First name of the staff member
String	UserPrefix	Prefix of the staff members name
String	UserLastName	Last name of the staff member
String	UserSuffix	Suffix of the staff members name
String	UserTitle	Title of the staff member
String	UserPhoneNumber	Phone number of the staff member
String	UserFaxNumber	Fax number of the staff member
String	UserMobileNumber	Mobile number of the staff member
String	UserRoomNumber	Room number of the staff member
String	UserPostcode	Postcode of the staff member
String	UserCity	City of the staff member
String	UserCountry	Country Name of the staff member
String	UserStreet	Street name of the staff member
String	UserStreetNumber	Street number of the staff members street
String	UserAddressAddition	Address adition of the staff members postal address
HealthInsuranceType	HealthInsuranceType	Type of the health insurance, e.g. National health insurance
String	HealthInsuranceId	Technical id of the choosen health insurance
String	HealthInsuranceName	Name of the choosen health insurance
String	HealthInsurancePolicyNumber	Policy number of the staff members health insurance
String	RegisteredInCountry	Code of the country where the user has his health insurance

ReportWorkdayDto

This class defines the working time model for a single working day.

Datatype	Name	Description
Bool	HasToWork	True, if the user has commonly to work the day.
Double	WorkmodelDefinedWorkTime	The amount of worktime that is defined for the day.
Double	WorkmodelDefinedPaidTime	The amount of paid time that is defined for the day.
DateTime	BeginOfWork	The planned begin of the workday
DateTime	EndOfWork	The planned end of the workday
Double	WorkmodelDefinedBreakTime	The breaktime that has been defined for the workday.
Double	EstimatedWorktime	The estimated worktime of the workday (public holidays will be evaluated too)
Double	EstimatedPaidtime	The estimated paidtime of the workday (public holidays will be evaluated too)
Double	EstimatedFractionOfDay	The estimated fraction of the workday (public holidays will be evaluated too).
Bool	IsShortTimeWorkToday	True, if the current workday is defined as a short time work
Bool	HasToWorkRegular	True, if the user must work regular on that day, in case of a short time work.
Double	WorkmodelDefinedWorkTimeRegular	The amount of worktime that is defined for the day, in case of a short time work.
Double	WorkmodelDefinedPaidTimeRegular	The amount of paid time that is defined for the day, in case of a short time work.
DateTime	BeginOfWorkRegular	The planned begin of the workday, in case of a short time work.
DateTime	EndOfWorkRegular	The planned end of the workday, in case of a short time work.
Bool	IsBreakDefinedRegular	True, if a break has been defined for the workday, in case of a short time work.
Double	WorkmodelDefinedBreakTimeRegular	The breaktime that has been defined for the workday, in case of a short time work.
Double	ForceBreakAboveRegular	The amount of work aboe that the break is mandatory, in case of a short time work.
Double	EstimatedDurationRegular	The estimated duration of the workday (public holidays will be evaluated too), in case of a short time work.
Double	EstimatedWorktimeRegular	The estimated worktime of the workday (public holidays will be evaluated too), in case of a short time work.
Double	EstimatedPaidtimeRegular	The estimated paidtime of the workday (public holidays will be evaluated too), in case of a short time work.
Double	EstimatedBreaktimeRegular	The estimated breaktime of the workday (public holidays will be evaluated too), in case of a short time work.
Double	EstimatedFractionOfDayRegular	The estimated fraction of the workday (public holidays will be evaluated too), in case of a short time work.

IMPORTANT: The Estimated… Properties will evaluate the public holidays, which is the main difference to the other fields.

ReportWorkModelDto

This class contains all the user-specific data of a working time model for reporting.

Datatype	Name	Description
String	DisplayName	Displayname of the work model.
DateTime	ValidSince	Date starting from that the work model is used.
Double	WorkdaysPerWeek	Amount of workdays per week.
Double	HoursPerWeek	Number of working hours per week.
Bool	SundayHasToWork	True, if Sunday is a regular working day.
Double	SundayEstimatedWorkTime	Estimated working time on Sunday.
Bool	MondayHasToWork	True, if Monday is a regular working day.
Double	MondayEstimatedWorkTime	Estimated working time on Monday.
Bool	TuesdayHasToWork	True, if Tuesday is a regular working day.
Double	TuesdayEstimatedWorkTime	Estimated working time on Tuesday.
Bool	WednesdayHasToWork	True, if Wednesday is a regular working day.
Double	WednesdayEstimatedWorkTime	Estimated working time on Wednesday.
Bool	ThursdayHasToWork	True, if Thursday is a regular working day.
Double	ThursdayEstimatedWorkTime	Estimated working time on Thursday.
Bool	FridayHasToWork	True, if Friday is a regular working day.
Double	FridayEstimatedWorkTime	Estimated working time on Friday.
Bool	SaturdayHasToWork	True, if Saturday is a regular working day.
Double	SaturdayEstimatedWorkTime	Estimated working time on Saturday.
Bool	IsShortTimeWork	True, if the day is defined as a short time work model
Double	WorkdaysPerWeekRegular	The regular workdays per week if the current work model is short time work.
Double	HoursPerWeekRegular	The regular hours per week if the current work model is short time work.

ReportYearlySummaryDto : ReportAuditEntityDto

This class contains all the data that is important for annual leave and reporting.

Datatype	Name	Description
Int	Year	Current year. E.g 2015
LeaveCarryForward	LeaveCarryForward	Defines the month, when the remaining leave will carried forward to the next year.
LeaveExpiration	LeaveExpiration	Defines the month, when the previous leave will expire in the current calculation period.
DateTime	StartOfYearlySummary	Date when the calculation of the new year starts.
DateTime	EndOfYearlySummary	Date when the calculation of the year ends
DateTime	LeaveExpirationDate	Date when the previous leave expires.
Double?	AdditionalLeave	Amount of additional leave hours from the previous year.
Double	AdditionalLeaveAsDays	Amount of additional leave days from the previous year.
LeaveCalculation	LeaveCalculation	Defines if the leave calculation is based on days or hours.
Double?	AnnualLeave	Amount of annual leave hours.
Double	AnnualLeaveAsDays	Amount of annual leave days
Double	LeavePerDay	Amount of hours that are calculated for one leave day.
Double	LeaveInYear	Taken leave hours in the current year.
Double	LeaveAsDaysInYear	Taken leave days in the current year.
Double	LeaveInYearUntilExpiration	Taken leave hours until the old leave expires.
Double	LeaveAsDaysInYearUntilExpiration	Taken leave days until the old leave expires.
Double	LeaveInYearNewPeriod	Taken leave hours in the new leave period of the current year.
Double	LeaveAsDaysInYearNewPeriod	Taken leave days in the new leave period of the current year.
Double	SickAsDaysInYear	Amount of sick days in year
Double	SickNotPaidAsDaysInYear	Amount of sick days that are not paid in the current year.
Double	SickCompleteAsDaysInYear	Amount of sick days and sick days not paid in year.
Double?	RemainingLeaveUntilExpiration	Remaining leave as hours until the old leave expires. NULL, if the leave is counted in days.
Double	RemainingLeaveAsDaysUntilExpiration	Remaining leave as days until the old leave expires.
Double?	RemainingLeaveNewPeriod	Remaining leave as hours in the new period. NULL, if the leave is counted in days.
Double	RemainingLeaveAsDaysNewPeriod	Remaining leave as days in the new period.